/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr.impl;

import java.util.Hashtable;

import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.addressing.FaultToDocument;
import cgl.narada.wsinfra.schemas.addressing.FromDocument;
import cgl.narada.wsinfra.schemas.addressing.ReplyAfterDocument;
import cgl.narada.wsinfra.schemas.addressing.ReplyToDocument;
import cgl.narada.wsinfra.schemas.addressing.ToDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.schemas.wsr.PollRequestDocument;
import cgl.narada.wsinfra.schemas.wsr.RequestDocument;
import cgl.narada.wsinfra.util.SoapMessageAlteration;
import cgl.narada.wsinfra.util.XmlContentTransfer;
import cgl.narada.wsinfra.wsa.WsaEnvelopeCreator;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wsr.WsrActions;
import cgl.narada.wsinfra.wsr.WsrElementCreation;
import cgl.narada.wsinfra.wsr.WsrProcessingFactory;
import cgl.narada.wsinfra.wsr.WsrQNames;
import cgl.narada.wsinfra.wsr.WsrRequestCreator;

/** A class which is responsible for creating WSR requests and WSR PollRequests.

    @author Sima Patel
    $Date: 2005/04/01 19:04:04 $
    $Revision: 1.4 $
*/


public class WsrRequestCreatorImpl implements WsrRequestCreator {
    private static final WsrRequestCreator instance = 
                                                    new WsrRequestCreatorImpl();
    private WsrActions wsrActions;
    private WsrQNames wsrQNames;
    private WsaEnvelopeCreator wsaEnvelopeCreator;
    private SoapMessageAlteration soapMessageAlteration;
    private XmlContentTransfer xmlContentTransfer;
    private WsrElementCreation wsrElementCreation;
    private String moduleName = "WsrRequestCreator: ";
    private WsrRequestCreatorImpl() {
        wsrActions = WsrActions.getInstance();
        wsaEnvelopeCreator = WsaProcessingFactory.getWsaEnvelopeCreator();
        soapMessageAlteration = SoapMessageAlteration.getInstance();
        xmlContentTransfer = XmlContentTransfer.getInstance();
        wsrElementCreation = WsrProcessingFactory.getWsrElementCreation();
    }
    public static WsrRequestCreator getInstance() {
      return instance;
    }
    /** Create a EnvelopeDocument containing PollRequest Document based on the 
    specified headers. The To, From and ReplyTo, FaultTo are appropriately 
    constructed. */
    public EnvelopeDocument getPollRequest(ToDocument to, 
			                   EndpointReferenceType wsrSourceEpr,
                                           Hashtable groupIdAndRangesTable) {
        if (to == null) {
            System.out.println(moduleName + "The <To> element cannot be NULL");
            return null;
        }
        if (wsrSourceEpr == null) {
            System.out.println(moduleName + 
                                        "The wsrSourceEpr Should NOT be null");
            return null;
        }
        FromDocument from = FromDocument.Factory.newInstance();
        from.setFrom(wsrSourceEpr);

        ActionDocument action = ActionDocument.Factory.newInstance();
        action.addNewAction().setStringValue(wsrActions.getProcessPollRequest());

        ReplyToDocument replyTo =null;
        ReplyAfterDocument replyAfter = null;
        FaultToDocument faultTo = null;
        PollRequestDocument pollRequestDocument = 
                wsrElementCreation.newPollRequest(groupIdAndRangesTable, 
                		wsrSourceEpr.getAddress().getStringValue());
        if(pollRequestDocument != null){

            EnvelopeDocument envelopeDocument = 
                         wsaEnvelopeCreator.createSoapEnvelope(to, from, action, 
                                                  replyTo, replyAfter, faultTo);

            soapMessageAlteration.addToSoapHeaderAsLastChild(
                                       envelopeDocument, pollRequestDocument);
            return envelopeDocument;
        }
        else{
            return null;
        }

    }
    /** Adds a Request Document in the header of Envelope Document*/
	public void addRequest(EnvelopeDocument envelopeDocument,
			               RequestDocument requestDocument){
		soapMessageAlteration.addToSoapHeader(envelopeDocument, requestDocument);
	}
  
}